Get Tenant by Name

{ getTenantByName }

Returns the AdminMultiTenantData object for the given tenant

Method

/API/admin/getTenantByName

  • API Section: /API/admin
  • API Version: 1.0
  • Method operates via POST actions only.

    • NOTE: API 1.0 methods are now deprecated. Use API 2.0 methods instead

    Input Parameters

    Name

    name

    Type

    string

    Description

    String

    Output Response

    Successful Result Code

    200

    Response Type

    AdminMultiTenantData

    Description of Response Type

    The tenant object contains all relevant meta-data for the tenant.